<!DOCTYPE html>

<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">

<title>module Trello - RDoc Documentation</title>

<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
</script>

<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>


<body id="top" class="module">
<nav id="metadata">
  <nav id="home-section" class="section">
  <h3 class="section-header">
    <a href="./index.html">Home</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </h3>
</nav>


  <nav id="search-section" class="section project-section" class="initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <h3 class="section-header">
      <input type="text" name="search" placeholder="Search" id="search-field"
             title="Type to search, Up and Down to navigate, Enter to load">
    </h3>
  </form>

  <ul id="search-results" class="initially-hidden"></ul>
</nav>


  <div id="file-metadata">
    <nav id="file-list-section" class="section">
  <h3 class="section-header">Defined In</h3>
  <ul>
    <li>lib/trello/action.rb
    <li>lib/trello/association.rb
    <li>lib/trello/association_proxy.rb
    <li>lib/trello/attachment.rb
    <li>lib/trello/authorization.rb
    <li>lib/trello/basic_data.rb
    <li>lib/trello/board.rb
    <li>lib/trello/card.rb
    <li>lib/trello/checklist.rb
    <li>lib/trello/client.rb
    <li>lib/trello/configuration.rb
    <li>lib/trello/has_actions.rb
    <li>lib/trello/item.rb
    <li>lib/trello/item_state.rb
    <li>lib/trello/label.rb
    <li>lib/trello/label_name.rb
    <li>lib/trello/list.rb
    <li>lib/trello/member.rb
    <li>lib/trello/multi_association.rb
    <li>lib/trello/net.rb
    <li>lib/trello/notification.rb
    <li>lib/trello/organization.rb
    <li>lib/trello/token.rb
    <li>lib/trello.rb
    <li>spec/action_spec.rb
    <li>spec/board_spec.rb
    <li>spec/card_spec.rb
    <li>spec/checklist_spec.rb
    <li>spec/item_spec.rb
    <li>spec/list_spec.rb
    <li>spec/member_spec.rb
    <li>spec/notification_spec.rb
    <li>spec/organization_spec.rb
    <li>spec/token_spec.rb
  </ul>
</nav>

    
  </div>

  <div id="class-metadata">
    
    
    <!-- Included Modules -->
<nav id="includes-section" class="section">
  <h3 class="section-header">Included Modules</h3>

  <ul class="link-list">
  
  
    <li><a class="include" href="Helpers.html">Helpers</a>
  
  
  </ul>
</nav>

    <!-- Method Quickref -->
<nav id="method-list-section" class="section">
  <h3 class="section-header">Methods</h3>

  <ul class="link-list">
    
    <li><a href="#method-c-auth_policy">::auth_policy</a>
    
    <li><a href="#method-c-client">::client</a>
    
    <li><a href="#method-c-configuration">::configuration</a>
    
    <li><a href="#method-c-configure">::configure</a>
    
    <li><a href="#method-c-logger">::logger</a>
    
    <li><a href="#method-c-logger-3D">::logger=</a>
    
    <li><a href="#method-c-reset-21">::reset!</a>
    
  </ul>
</nav>

  </div>

  <div id="project-metadata">
    <nav id="fileindex-section" class="section project-section">
  <h3 class="section-header">Pages</h3>

  <ul>
  
    <li class="file"><a href="./Gemfile.html">Gemfile</a>
  
    <li class="file"><a href="./LICENSE.html">LICENSE</a>
  
    <li class="file"><a href="./Rakefile.html">Rakefile</a>
  
  </ul>
</nav>

    <nav id="classindex-section" class="section project-section">
  <h3 class="section-header">Class and Module Index</h3>

  <ul class="link-list">
  
    <li><a href="./Trello.html">Trello</a>
  
    <li><a href="./Trello/Action.html">Trello::Action</a>
  
    <li><a href="./Trello/Association.html">Trello::Association</a>
  
    <li><a href="./Trello/AssociationProxy.html">Trello::AssociationProxy</a>
  
    <li><a href="./Trello/Attachment.html">Trello::Attachment</a>
  
    <li><a href="./Trello/Authorization.html">Trello::Authorization</a>
  
    <li><a href="./Trello/Authorization/BasicAuthPolicy.html">Trello::Authorization::BasicAuthPolicy</a>
  
    <li><a href="./Trello/Authorization/Clock.html">Trello::Authorization::Clock</a>
  
    <li><a href="./Trello/Authorization/Nonce.html">Trello::Authorization::Nonce</a>
  
    <li><a href="./Trello/Authorization/OAuthPolicy.html">Trello::Authorization::OAuthPolicy</a>
  
    <li><a href="./Trello/BasicData.html">Trello::BasicData</a>
  
    <li><a href="./Trello/Board.html">Trello::Board</a>
  
    <li><a href="./Trello/Card.html">Trello::Card</a>
  
    <li><a href="./Trello/CheckItemState.html">Trello::CheckItemState</a>
  
    <li><a href="./Trello/Checklist.html">Trello::Checklist</a>
  
    <li><a href="./Trello/Client.html">Trello::Client</a>
  
    <li><a href="./Trello/Configuration.html">Trello::Configuration</a>
  
    <li><a href="./Trello/Error.html">Trello::Error</a>
  
    <li><a href="./Trello/HasActions.html">Trello::HasActions</a>
  
    <li><a href="./Trello/InvalidAccessToken.html">Trello::InvalidAccessToken</a>
  
    <li><a href="./Trello/Item.html">Trello::Item</a>
  
    <li><a href="./Trello/Label.html">Trello::Label</a>
  
    <li><a href="./Trello/LabelName.html">Trello::LabelName</a>
  
    <li><a href="./Trello/List.html">Trello::List</a>
  
    <li><a href="./Trello/Member.html">Trello::Member</a>
  
    <li><a href="./Trello/MultiAssociation.html">Trello::MultiAssociation</a>
  
    <li><a href="./Trello/Notification.html">Trello::Notification</a>
  
    <li><a href="./Trello/Organization.html">Trello::Organization</a>
  
    <li><a href="./Trello/TInternet.html">Trello::TInternet</a>
  
    <li><a href="./Trello/Token.html">Trello::Token</a>
  
    <li><a href="./IntegrationTest.html">IntegrationTest</a>
  
    <li><a href="./IntegrationTest/Container.html">IntegrationTest::Container</a>
  
    <li><a href="./Helpers.html">Helpers</a>
  
    <li><a href="./Object.html">Object</a>
  
    <li><a href="./String.html">String</a>
  
  </ul>
</nav>

  </div>
</nav>

<div id="documentation">
  <h1 class="module">module Trello</h1>

  <div id="description" class="description">
    
<p>Ruby wrapper around the <a href="http://trello.com">Trello</a> API</p>

<p>First, set up your key information. You can get this information by <a
href="https://trello.com/1/appKey/generate">clicking here</a>.</p>

<p>You can get the key by going to this url in your browser: <a
href="https://trello.com/1/authorize?key=TRELLO_CONSUMER_KEY_FROM_ABOVE&name=MyApp&response_type=token&scope=read,write,account&expiration=never">trello.com/1/authorize?key=TRELLO_CONSUMER_KEY_FROM_ABOVE&name=MyApp&response_type=token&scope=read,write,account&expiration=never</a>
Only request the permissions you need; i.e., scope=read if you only need
read, or scope=write if you only need write. Comma separate scopes you
need. If you want your token to expire after 30 days, drop the
&amp;expiration=never. Then run the following code, where KEY denotes the
key returned from the url above:</p>

<p><a href="Trello.html#method-c-configure">::configure</a> do |config|</p>

<pre>config.consumer_key = TRELLO_CONSUMER_KEY
config.consumer_secret = TRELLO_CONSUMER_SECRET
config.oauth_token = TRELLO_OAUTH_TOKEN
config.oauth_token_secret = TRELLO_OAUTH_TOKEN_SECRET</pre>

<p>end</p>

<p>All the calls this library make to <a href="Trello.html">Trello</a> require
authentication using these keys. Be sure to protect them.</p>

<p>So lets say you want to get information about the user
<strong>bobtester</strong>. We can do something like this:</p>

<pre>bob = Member.find(&quot;bobtester&quot;)
# Print out his name
puts bob.full_name # &quot;Bob Tester&quot;
# Print his bio
puts bob.bio # A wonderfully delightful test user
# How about a list of his boards?
bob.boards</pre>

<p>And so much more. Consult the rest of the documentation for more
information.</p>

<p>Feel free to <a
href="https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd">peruse
and participate in our Trello board</a>. It’s completely open to the
public.</p>

  </div><!-- description -->

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    
    <!-- Constants -->
    <section id="constants-list" class="section">
      <h3 class="section-header">Constants</h3>
      <dl>
      
        <dt id="API_VERSION">API_VERSION
        
        <dd class="description"><p>Version of the <a href="Trello.html">Trello</a> API that we use by default.</p>
        
      
        <dt id="Request">Request
        
        <dd class="description">
        
      
        <dt id="Response">Response
        
        <dd class="description">
        
      
      </dl>
    </section>
    

    

    <!-- Methods -->
    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Class Methods</h3>

    
      <div id="method-c-auth_policy" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">auth_policy</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="auth_policy-source">
            <pre><span class="ruby-comment"># File lib/trello.rb, line 99</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">auth_policy</span>; <span class="ruby-identifier">client</span>.<span class="ruby-identifier">auth_policy</span>; <span class="ruby-keyword">end</span></pre>
          </div><!-- auth_policy-source -->
          
        </div>

        

        
      </div><!-- auth_policy-method -->

    
      <div id="method-c-client" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">client</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="client-source">
            <pre><span class="ruby-comment"># File lib/trello.rb, line 86</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">client</span>
  <span class="ruby-ivar">@client</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- client-source -->
          
        </div>

        

        
      </div><!-- client-method -->

    
      <div id="method-c-configuration" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">configuration</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="configuration-source">
            <pre><span class="ruby-comment"># File lib/trello.rb, line 100</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">configuration</span>; <span class="ruby-identifier">client</span>.<span class="ruby-identifier">configuration</span>; <span class="ruby-keyword">end</span></pre>
          </div><!-- configuration-source -->
          
        </div>

        

        
      </div><!-- configuration-method -->

    
      <div id="method-c-configure" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">configure</span><span
            class="method-args">(&block)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="configure-source">
            <pre><span class="ruby-comment"># File lib/trello.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">configure</span>(&amp;<span class="ruby-identifier">block</span>)
  <span class="ruby-identifier">reset!</span>
  <span class="ruby-identifier">client</span>.<span class="ruby-identifier">configure</span>(&amp;<span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- configure-source -->
          
        </div>

        

        
      </div><!-- configure-method -->

    
      <div id="method-c-logger" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">logger</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="logger-source">
            <pre><span class="ruby-comment"># File lib/trello.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">logger</span>
  <span class="ruby-ivar">@logger</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">STDOUT</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- logger-source -->
          
        </div>

        

        
      </div><!-- logger-method -->

    
      <div id="method-c-logger-3D" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">logger=</span><span
            class="method-args">(logger)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="logger-3D-source">
            <pre><span class="ruby-comment"># File lib/trello.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">logger=</span>(<span class="ruby-identifier">logger</span>)
  <span class="ruby-ivar">@logger</span> = <span class="ruby-identifier">logger</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- logger-3D-source -->
          
        </div>

        

        
      </div><!-- logger-3D-method -->

    
      <div id="method-c-reset-21" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">reset!</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="reset-21-source">
            <pre><span class="ruby-comment"># File lib/trello.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">reset!</span>
  <span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- reset-21-source -->
          
        </div>

        

        
      </div><!-- reset-21-method -->

    
    </section><!-- public-class-method-details -->
  
  </section><!-- 5Buntitled-5D -->

</div><!-- documentation -->


<footer id="validator-badges">
  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>

